Skip to main content
Feedback

Configuring a REST endpoint in an API service component

In an API Service component, configure a REST endpoint on the REST tab.

Prerequisites

  • You have an API Service component with a REST endpoint to configure.

Procedure

  1. In the API Service component, select the REST tab.

  2. In the Main ic gear black a176 436a 86ca Actions menu for the endpoint you want to configure, select Edit Endpoint.

  3. If the URL path for requests for the route’s specified operation is not yet set, type the path in the Resource Path field.

    To specify parameters in the path, delineate them with braces — for example, {id}. Parameters in the matched part of the path are available to the linked process as dynamic process properties named param_name, where name is the parameter name — for example, param_id.

    The full URL has this form:

    http://Host:port/REST_url_path/Object/Url_path

    where

    • Host and port are set on the Shared Web Server panel (Manage > Runtime Management).

    • REST_url_path is the REST URL Path specified in the General tab (this path contains the Base URL set in that same tab),

    • Object is the Object you specified when you added the resource to the REST API.

    • Url_path is the URL Path you specify in this step or specified when you added the route.

    For example:

    http://machine.domain.tld:9090/ws/rest/Customer/{customerId}
    note

    In steps 8–16 you can override the default settings derived from the linked process for the route’s specified operation. Refer to the topic about the REST tab for information about the settings.

  4. Select the HTTP Method (GET, POST, PUT, DELETE, or PATCH) for this endpoint.

  5. Optional: The Match the exact endpoint checkbox controls how the system routes incoming API requests. The endpoint responds only to precisely defined requests, including path and query parameters, and does not allow variations. This means the system requires static path components to match exactly. Any request must have the same structure as you define in the endpoint configuration. While the system recognizes path variables and captures their values, their positions within the path must also align precisely with the structure you define. The system honors exact match configurations only if you deploy the corresponding process; if you do not, it considers the endpoint undeployed, and its configuration does not apply.

    • Checked: Requires an exact structural match of path and parameters.
    • Unchecked: Uses the Best Match principle to find the closest pattern among deployed endpoints.

  6. In the Endpoint Name field, type a unique name for the endpoint. This name is used as the operationId in the generated OpenAPI specification file to help identify the operation.

  7. Optional: In the Endpoint Description field, provide a clear, concise explanation of the endpoint's purpose. This description is exported to the OpenAPI specification to assist API consumers.

  8. Optional: Set an override for the operation’s HTTP Method.

  9. Optional: Define HTTP routing headers to be matched in requests for the operation.

    1. Expand Routing Headers.

    2. Click Main ic plus sign white in green circle e893 4aef Add HTTP Header.

    3. In the Key field, type the name of the first header.

    4. In the Value field, type the header value.

    For each additional header you are defining, repeat steps 2-4 for that header.

  10. Optional: Define query parameters for the operation. Query parameters defined here are included in the generated OpenAPI specification file.

  11. Expand Query Parameters.

  12. Click Main ic plus sign white in green circle e893 4aef Add Query Parameter.

  13. Add the Name of the query parameter.

  14. Select a base type: string, boolean, integer, or number.

  15. Select the Required check box if necessary.

  16. Add a Description.

  17. If a Web Services Server listener process is not already linked to the route, click the magnifying glass icon adjacent to the Request Handled by Process field. In the component browser, select the process to link.

The Request Handled by Process field populates, along with the default settings for the route’s specified operation. The default settings are derived from the Web Services Server connector operation used in that process.

  1. Optional: Set an override for the operation’s Input Type.

  2. Optional: Set an override for the operation’s Input Profile for Request. This is an option only for an operation with its Input Type set to Single JSON Object, Multiple JSON Objects, Single XML Object or Multiple XML Objects.

    If you set an override, the profile’s name appears in black.

  3. Optional: Set an override for the operation’s Output Type.

  4. Optional: Set an override for the operation’s Output Profile for Response. This is an option only for an operation with its Output Type set to Single JSON Object, Multiple JSON Objects, Single XML Object or Multiple XML Objects.

    If you set an override, the profile’s name appears in black.

  5. Optional: Set an override for the operation’s output Internet Media Type for Output (Internet media type) . This is an option only for an operation with its Output Type set to Single Data.

  6. Optional: Set an override for the operation’s output Number of Documents Returned. This is an option only for an operation with its Output Type set to Multiple JSON Objects or Multiple XML Objects.

  7. Optional In the Additional Responses section, select Add Response and add the following for each response:

    • Response Code - Set to a number between 100-599. You can also use 1XX, 2XX, 3XX, 4XX, 5XX, or default.
    • Description - Details about the response.
    • Output Type - Single Data, Single JSON Object, Single XML Object, or Multipart/form-data.
    • Output Profile/Media Type

  8. Click Save or Save and Close.

On this Page